Api.GetVariables method

Gets the list of user-defined variables.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB
public KsReturn<UserVariable[]> GetVariables(
       UserVariable Parent = null
)
Public Function GetVariables(
       Parent = null As UserVariable
) As KsReturn(Of UserVariable())

Parameters

Parent

Type: UserVariable

Default value: null

The parent folder of UserVariable. By default, it gets variables from the root folder.

Return value

Type: KsReturn<UserVariable[]>

Returns a KsError code and a UserVariable value.

Remarks

The variable can be used in KINGSTAR Scope and a real-time log.

Usable EtherCAT states

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

Examples

C#
N/A

See also

Api Class

IntervalZero.KINGSTAR.Local.Api Namespace